﻿#region Using directives

using System;
using System.Data;
using System.Data.Common;
using System.Collections;
using System.Collections.Generic;

using SecurityFoundation.Entities;
using SecurityFoundation.Data;

#endregion

namespace SecurityFoundation.Data.Bases
{	
	///<summary>
	/// This class is the base class for any <see cref="SecurityTokenProviderBase"/> implementation.
	/// It exposes CRUD methods as well as selecting on index, foreign keys and custom stored procedures.
	///</summary>
	public abstract partial class SecurityTokenProviderBaseCore : EntityProviderBase<SecurityFoundation.Entities.SecurityToken, SecurityFoundation.Entities.SecurityTokenKey>
	{		
		#region Get from Many To Many Relationship Functions
		#endregion	
		
		#region Delete Methods

		/// <summary>
		/// 	Deletes a row from the DataSource.
		/// </summary>
		/// <param name="transactionManager">A <see cref="TransactionManager"/> object.</param>
		/// <param name="key">The unique identifier of the row to delete.</param>
		/// <returns>Returns true if operation suceeded.</returns>
		public override bool Delete(TransactionManager transactionManager, SecurityFoundation.Entities.SecurityTokenKey key)
		{
			return Delete(transactionManager, key.TokenKey);
		}
		
		/// <summary>
		/// 	Deletes a row from the DataSource.
		/// </summary>
		/// <param name="_tokenKey">. Primary Key.</param>
		/// <remarks>Deletes based on primary key(s).</remarks>
		/// <returns>Returns true if operation suceeded.</returns>
		public bool Delete(System.Guid _tokenKey)
		{
			return Delete(null, _tokenKey);
		}
		
		/// <summary>
		/// 	Deletes a row from the DataSource.
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_tokenKey">. Primary Key.</param>
		/// <remarks>Deletes based on primary key(s).</remarks>
		/// <returns>Returns true if operation suceeded.</returns>
		public abstract bool Delete(TransactionManager transactionManager, System.Guid _tokenKey);		
		
		#endregion Delete Methods
		
		#region Get By Foreign Key Functions
	
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		FK_SecurityToken_ApplicationDefination Description: 
		/// </summary>
		/// <param name="_sourceApplication"></param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetBySourceApplication(System.Guid _sourceApplication)
		{
			int count = -1;
			return GetBySourceApplication(_sourceApplication, 0,int.MaxValue, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		FK_SecurityToken_ApplicationDefination Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_sourceApplication"></param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		/// <remarks></remarks>
		public TList<SecurityToken> GetBySourceApplication(TransactionManager transactionManager, System.Guid _sourceApplication)
		{
			int count = -1;
			return GetBySourceApplication(transactionManager, _sourceApplication, 0, int.MaxValue, out count);
		}
		
			/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		FK_SecurityToken_ApplicationDefination Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_sourceApplication"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		///  <param name="pageLength">Number of rows to return.</param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetBySourceApplication(TransactionManager transactionManager, System.Guid _sourceApplication, int start, int pageLength)
		{
			int count = -1;
			return GetBySourceApplication(transactionManager, _sourceApplication, start, pageLength, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		fkSecurityTokenApplicationDefination Description: 
		/// </summary>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="_sourceApplication"></param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetBySourceApplication(System.Guid _sourceApplication, int start, int pageLength)
		{
			int count =  -1;
			return GetBySourceApplication(null, _sourceApplication, start, pageLength,out count);	
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		fkSecurityTokenApplicationDefination Description: 
		/// </summary>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="_sourceApplication"></param>
		/// <param name="count">out parameter to get total records for query</param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetBySourceApplication(System.Guid _sourceApplication, int start, int pageLength,out int count)
		{
			return GetBySourceApplication(null, _sourceApplication, start, pageLength, out count);	
		}
						
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_ApplicationDefination key.
		///		FK_SecurityToken_ApplicationDefination Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_sourceApplication"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="count">The total number of records.</param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public abstract TList<SecurityToken> GetBySourceApplication(TransactionManager transactionManager, System.Guid _sourceApplication, int start, int pageLength, out int count);
		
	
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		FK_SecurityToken_Realm Description: 
		/// </summary>
		/// <param name="_realm"></param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetByRealm(System.Guid _realm)
		{
			int count = -1;
			return GetByRealm(_realm, 0,int.MaxValue, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		FK_SecurityToken_Realm Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_realm"></param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		/// <remarks></remarks>
		public TList<SecurityToken> GetByRealm(TransactionManager transactionManager, System.Guid _realm)
		{
			int count = -1;
			return GetByRealm(transactionManager, _realm, 0, int.MaxValue, out count);
		}
		
			/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		FK_SecurityToken_Realm Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_realm"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		///  <param name="pageLength">Number of rows to return.</param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetByRealm(TransactionManager transactionManager, System.Guid _realm, int start, int pageLength)
		{
			int count = -1;
			return GetByRealm(transactionManager, _realm, start, pageLength, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		fkSecurityTokenRealm Description: 
		/// </summary>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="_realm"></param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetByRealm(System.Guid _realm, int start, int pageLength)
		{
			int count =  -1;
			return GetByRealm(null, _realm, start, pageLength,out count);	
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		fkSecurityTokenRealm Description: 
		/// </summary>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="_realm"></param>
		/// <param name="count">out parameter to get total records for query</param>
		/// <remarks></remarks>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public TList<SecurityToken> GetByRealm(System.Guid _realm, int start, int pageLength,out int count)
		{
			return GetByRealm(null, _realm, start, pageLength, out count);	
		}
						
		/// <summary>
		/// 	Gets rows from the datasource based on the FK_SecurityToken_Realm key.
		///		FK_SecurityToken_Realm Description: 
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_realm"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="count">The total number of records.</param>
		/// <returns>Returns a typed collection of SecurityFoundation.Entities.SecurityToken objects.</returns>
		public abstract TList<SecurityToken> GetByRealm(TransactionManager transactionManager, System.Guid _realm, int start, int pageLength, out int count);
		
		#endregion

		#region Get By Index Functions
		
		/// <summary>
		/// 	Gets a row from the DataSource based on its primary key.
		/// </summary>
		/// <param name="transactionManager">A <see cref="TransactionManager"/> object.</param>
		/// <param name="key">The unique identifier of the row to retrieve.</param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <returns>Returns an instance of the Entity class.</returns>
		public override SecurityFoundation.Entities.SecurityToken Get(TransactionManager transactionManager, SecurityFoundation.Entities.SecurityTokenKey key, int start, int pageLength)
		{
			return GetByTokenKey(transactionManager, key.TokenKey, start, pageLength);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the primary key PK_SecurityToken index.
		/// </summary>
		/// <param name="_tokenKey"></param>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public SecurityFoundation.Entities.SecurityToken GetByTokenKey(System.Guid _tokenKey)
		{
			int count = -1;
			return GetByTokenKey(null,_tokenKey, 0, int.MaxValue, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the PK_SecurityToken index.
		/// </summary>
		/// <param name="_tokenKey"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <remarks></remarks>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public SecurityFoundation.Entities.SecurityToken GetByTokenKey(System.Guid _tokenKey, int start, int pageLength)
		{
			int count = -1;
			return GetByTokenKey(null, _tokenKey, start, pageLength, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the PK_SecurityToken index.
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_tokenKey"></param>
		/// <remarks></remarks>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public SecurityFoundation.Entities.SecurityToken GetByTokenKey(TransactionManager transactionManager, System.Guid _tokenKey)
		{
			int count = -1;
			return GetByTokenKey(transactionManager, _tokenKey, 0, int.MaxValue, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the PK_SecurityToken index.
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_tokenKey"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <remarks></remarks>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public SecurityFoundation.Entities.SecurityToken GetByTokenKey(TransactionManager transactionManager, System.Guid _tokenKey, int start, int pageLength)
		{
			int count = -1;
			return GetByTokenKey(transactionManager, _tokenKey, start, pageLength, out count);
		}
		
		/// <summary>
		/// 	Gets rows from the datasource based on the PK_SecurityToken index.
		/// </summary>
		/// <param name="_tokenKey"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="count">out parameter to get total records for query</param>
		/// <remarks></remarks>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public SecurityFoundation.Entities.SecurityToken GetByTokenKey(System.Guid _tokenKey, int start, int pageLength, out int count)
		{
			return GetByTokenKey(null, _tokenKey, start, pageLength, out count);
		}
		
				
		/// <summary>
		/// 	Gets rows from the datasource based on the PK_SecurityToken index.
		/// </summary>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="_tokenKey"></param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="count">The total number of records.</param>
		/// <returns>Returns an instance of the <see cref="SecurityFoundation.Entities.SecurityToken"/> class.</returns>
		public abstract SecurityFoundation.Entities.SecurityToken GetByTokenKey(TransactionManager transactionManager, System.Guid _tokenKey, int start, int pageLength, out int count);
						
		#endregion "Get By Index Functions"
	
		#region Custom Methods
		
		
		#region usp_SecurityToken_FindByUser 
		
		/// <summary>
		///	This method wrap the 'usp_SecurityToken_FindByUser' stored procedure. 
		/// </summary>
		/// <param name="realm"> A <c>System.Guid?</c> instance.</param>
		/// <param name="sourceApp"> A <c>System.Guid?</c> instance.</param>
		/// <param name="userName"> A <c>System.String</c> instance.</param>
		/// <remark>This method is generate from a stored procedure.</remark>
		/// <returns>A <see cref="TList&lt;SecurityToken&gt;"/> instance.</returns>
		public TList<SecurityToken> FindByUser(System.Guid? realm, System.Guid? sourceApp, System.String userName)
		{
			return FindByUser(null, 0, int.MaxValue , realm, sourceApp, userName);
		}
		
		/// <summary>
		///	This method wrap the 'usp_SecurityToken_FindByUser' stored procedure. 
		/// </summary>
		/// <param name="realm"> A <c>System.Guid?</c> instance.</param>
		/// <param name="sourceApp"> A <c>System.Guid?</c> instance.</param>
		/// <param name="userName"> A <c>System.String</c> instance.</param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <remark>This method is generate from a stored procedure.</remark>
		/// <returns>A <see cref="TList&lt;SecurityToken&gt;"/> instance.</returns>
		public TList<SecurityToken> FindByUser(int start, int pageLength, System.Guid? realm, System.Guid? sourceApp, System.String userName)
		{
			return FindByUser(null, start, pageLength , realm, sourceApp, userName);
		}
				
		/// <summary>
		///	This method wrap the 'usp_SecurityToken_FindByUser' stored procedure. 
		/// </summary>
		/// <param name="realm"> A <c>System.Guid?</c> instance.</param>
		/// <param name="sourceApp"> A <c>System.Guid?</c> instance.</param>
		/// <param name="userName"> A <c>System.String</c> instance.</param>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <remark>This method is generate from a stored procedure.</remark>
		/// <returns>A <see cref="TList&lt;SecurityToken&gt;"/> instance.</returns>
		public TList<SecurityToken> FindByUser(TransactionManager transactionManager, System.Guid? realm, System.Guid? sourceApp, System.String userName)
		{
			return FindByUser(transactionManager, 0, int.MaxValue , realm, sourceApp, userName);
		}
		
		/// <summary>
		///	This method wrap the 'usp_SecurityToken_FindByUser' stored procedure. 
		/// </summary>
		/// <param name="realm"> A <c>System.Guid?</c> instance.</param>
		/// <param name="sourceApp"> A <c>System.Guid?</c> instance.</param>
		/// <param name="userName"> A <c>System.String</c> instance.</param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">Number of rows to return.</param>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <remark>This method is generate from a stored procedure.</remark>
		/// <returns>A <see cref="TList&lt;SecurityToken&gt;"/> instance.</returns>
		public abstract TList<SecurityToken> FindByUser(TransactionManager transactionManager, int start, int pageLength , System.Guid? realm, System.Guid? sourceApp, System.String userName);
		
		#endregion
		
		#endregion

		#region Helper Functions	
		
		/// <summary>
		/// Fill a TList&lt;SecurityToken&gt; From a DataReader.
		/// </summary>
		/// <param name="reader">Datareader</param>
		/// <param name="rows">The collection to fill</param>
		/// <param name="start">Row number at which to start reading, the first row is 0.</param>
		/// <param name="pageLength">number of rows.</param>
		/// <returns>a <see cref="TList&lt;SecurityToken&gt;"/></returns>
		public static TList<SecurityToken> Fill(IDataReader reader, TList<SecurityToken> rows, int start, int pageLength)
		{
			NetTiersProvider currentProvider = DataRepository.Provider;
            bool useEntityFactory = currentProvider.UseEntityFactory;
            bool enableEntityTracking = currentProvider.EnableEntityTracking;
            LoadPolicy currentLoadPolicy = currentProvider.CurrentLoadPolicy;
			Type entityCreationFactoryType = currentProvider.EntityCreationalFactoryType;
			
			// advance to the starting row
			for (int i = 0; i < start; i++)
			{
				if (!reader.Read())
				return rows; // not enough rows, just return
			}
			for (int i = 0; i < pageLength; i++)
			{
				if (!reader.Read())
					break; // we are done
					
				string key = null;
				
				SecurityFoundation.Entities.SecurityToken c = null;
				if (useEntityFactory)
				{
					key = new System.Text.StringBuilder("SecurityToken")
					.Append("|").Append((System.Guid)reader[((int)SecurityTokenColumn.TokenKey - 1)]).ToString();
					c = EntityManager.LocateOrCreate<SecurityToken>(
					key.ToString(), // EntityTrackingKey
					"SecurityToken",  //Creational Type
					entityCreationFactoryType,  //Factory used to create entity
					enableEntityTracking); // Track this entity?
				}
				else
				{
					c = new SecurityFoundation.Entities.SecurityToken();
				}
				
				if (!enableEntityTracking ||
					c.EntityState == EntityState.Added ||
					(enableEntityTracking &&
					
						(
							(currentLoadPolicy == LoadPolicy.PreserveChanges && c.EntityState == EntityState.Unchanged) ||
							(currentLoadPolicy == LoadPolicy.DiscardChanges && c.EntityState != EntityState.Unchanged)
						)
					))
				{
					c.SuppressEntityEvents = true;
					c.TokenKey = (System.Guid)reader[((int)SecurityTokenColumn.TokenKey - 1)];
					c.OriginalTokenKey = c.TokenKey;
					c.Realm = (System.Guid)reader[((int)SecurityTokenColumn.Realm - 1)];
					c.SourceApplication = (System.Guid)reader[((int)SecurityTokenColumn.SourceApplication - 1)];
					c.TokenCreated = (System.DateTime)reader[((int)SecurityTokenColumn.TokenCreated - 1)];
					c.UserName = (System.String)reader[((int)SecurityTokenColumn.UserName - 1)];
					c.EntityTrackingKey = key;
					c.AcceptChanges();
					c.SuppressEntityEvents = false;
				}
				rows.Add(c);
			}
		return rows;
		}		
		/// <summary>
		/// Refreshes the <see cref="SecurityFoundation.Entities.SecurityToken"/> object from the <see cref="IDataReader"/>.
		/// </summary>
		/// <param name="reader">The <see cref="IDataReader"/> to read from.</param>
		/// <param name="entity">The <see cref="SecurityFoundation.Entities.SecurityToken"/> object to refresh.</param>
		public static void RefreshEntity(IDataReader reader, SecurityFoundation.Entities.SecurityToken entity)
		{
			if (!reader.Read()) return;
			
			entity.TokenKey = (System.Guid)reader[((int)SecurityTokenColumn.TokenKey - 1)];
			entity.OriginalTokenKey = (System.Guid)reader["TokenKey"];
			entity.Realm = (System.Guid)reader[((int)SecurityTokenColumn.Realm - 1)];
			entity.SourceApplication = (System.Guid)reader[((int)SecurityTokenColumn.SourceApplication - 1)];
			entity.TokenCreated = (System.DateTime)reader[((int)SecurityTokenColumn.TokenCreated - 1)];
			entity.UserName = (System.String)reader[((int)SecurityTokenColumn.UserName - 1)];
			entity.AcceptChanges();
		}
		
		/// <summary>
		/// Refreshes the <see cref="SecurityFoundation.Entities.SecurityToken"/> object from the <see cref="DataSet"/>.
		/// </summary>
		/// <param name="dataSet">The <see cref="DataSet"/> to read from.</param>
		/// <param name="entity">The <see cref="SecurityFoundation.Entities.SecurityToken"/> object.</param>
		public static void RefreshEntity(DataSet dataSet, SecurityFoundation.Entities.SecurityToken entity)
		{
			DataRow dataRow = dataSet.Tables[0].Rows[0];
			
			entity.TokenKey = (System.Guid)dataRow["TokenKey"];
			entity.OriginalTokenKey = (System.Guid)dataRow["TokenKey"];
			entity.Realm = (System.Guid)dataRow["Realm"];
			entity.SourceApplication = (System.Guid)dataRow["SourceApplication"];
			entity.TokenCreated = (System.DateTime)dataRow["TokenCreated"];
			entity.UserName = (System.String)dataRow["UserName"];
			entity.AcceptChanges();
		}
		#endregion 
		
		#region DeepLoad Methods
		/// <summary>
		/// Deep Loads the <see cref="IEntity"/> object with criteria based of the child 
		/// property collections only N Levels Deep based on the <see cref="DeepLoadType"/>.
		/// </summary>
		/// <remarks>
		/// Use this method with caution as it is possible to DeepLoad with Recursion and traverse an entire object graph.
		/// </remarks>
		/// <param name="transactionManager"><see cref="TransactionManager"/> object</param>
		/// <param name="entity">The <see cref="SecurityFoundation.Entities.SecurityToken"/> object to load.</param>
		/// <param name="deep">Boolean. A flag that indicates whether to recursively save all Property Collection that are descendants of this instance. If True, saves the complete object graph below this object. If False, saves this object only. </param>
		/// <param name="deepLoadType">DeepLoadType Enumeration to Include/Exclude object property collections from Load.</param>
		/// <param name="childTypes">SecurityFoundation.Entities.SecurityToken Property Collection Type Array To Include or Exclude from Load</param>
		/// <param name="innerList">A collection of child types for easy access.</param>
	    /// <exception cref="ArgumentNullException">entity or childTypes is null.</exception>
	    /// <exception cref="ArgumentException">deepLoadType has invalid value.</exception>
		public override void DeepLoad(TransactionManager transactionManager, SecurityFoundation.Entities.SecurityToken entity, bool deep, DeepLoadType deepLoadType, System.Type[] childTypes, DeepSession innerList)
		{
			if(entity == null)
				return;

			#region SourceApplicationSource	
			if (CanDeepLoad(entity, "ApplicationDefination|SourceApplicationSource", deepLoadType, innerList) 
				&& entity.SourceApplicationSource == null)
			{
				object[] pkItems = new object[1];
				pkItems[0] = entity.SourceApplication;
				ApplicationDefination tmpEntity = EntityManager.LocateEntity<ApplicationDefination>(EntityLocator.ConstructKeyFromPkItems(typeof(ApplicationDefination), pkItems), DataRepository.Provider.EnableEntityTracking);
				if (tmpEntity != null)
					entity.SourceApplicationSource = tmpEntity;
				else
					entity.SourceApplicationSource = DataRepository.ApplicationDefinationProvider.GetByApplicationKey(transactionManager, entity.SourceApplication);		
				
				#if NETTIERS_DEBUG
				System.Diagnostics.Debug.WriteLine("- property 'SourceApplicationSource' loaded. key " + entity.EntityTrackingKey);
				#endif 
				
				if (deep && entity.SourceApplicationSource != null)
				{
					innerList.SkipChildren = true;
					DataRepository.ApplicationDefinationProvider.DeepLoad(transactionManager, entity.SourceApplicationSource, deep, deepLoadType, childTypes, innerList);
					innerList.SkipChildren = false;
				}
					
			}
			#endregion SourceApplicationSource

			#region RealmSource	
			if (CanDeepLoad(entity, "Realm|RealmSource", deepLoadType, innerList) 
				&& entity.RealmSource == null)
			{
				object[] pkItems = new object[1];
				pkItems[0] = entity.Realm;
				Realm tmpEntity = EntityManager.LocateEntity<Realm>(EntityLocator.ConstructKeyFromPkItems(typeof(Realm), pkItems), DataRepository.Provider.EnableEntityTracking);
				if (tmpEntity != null)
					entity.RealmSource = tmpEntity;
				else
					entity.RealmSource = DataRepository.RealmProvider.GetByRealmId(transactionManager, entity.Realm);		
				
				#if NETTIERS_DEBUG
				System.Diagnostics.Debug.WriteLine("- property 'RealmSource' loaded. key " + entity.EntityTrackingKey);
				#endif 
				
				if (deep && entity.RealmSource != null)
				{
					innerList.SkipChildren = true;
					DataRepository.RealmProvider.DeepLoad(transactionManager, entity.RealmSource, deep, deepLoadType, childTypes, innerList);
					innerList.SkipChildren = false;
				}
					
			}
			#endregion RealmSource
			
			//used to hold DeepLoad method delegates and fire after all the local children have been loaded.
			Dictionary<string, KeyValuePair<Delegate, object>> deepHandles = new Dictionary<string, KeyValuePair<Delegate, object>>();
			
			//Fire all DeepLoad Items
			foreach(KeyValuePair<Delegate, object> pair in deepHandles.Values)
		    {
                pair.Key.DynamicInvoke((object[])pair.Value);
		    }
			deepHandles = null;
		}
		
		#endregion 
		
		#region DeepSave Methods

		/// <summary>
		/// Deep Save the entire object graph of the SecurityFoundation.Entities.SecurityToken object with criteria based of the child 
		/// Type property array and DeepSaveType.
		/// </summary>
		/// <param name="transactionManager">The transaction manager.</param>
		/// <param name="entity">SecurityFoundation.Entities.SecurityToken instance</param>
		/// <param name="deepSaveType">DeepSaveType Enumeration to Include/Exclude object property collections from Save.</param>
		/// <param name="childTypes">SecurityFoundation.Entities.SecurityToken Property Collection Type Array To Include or Exclude from Save</param>
		/// <param name="innerList">A Hashtable of child types for easy access.</param>
		public override bool DeepSave(TransactionManager transactionManager, SecurityFoundation.Entities.SecurityToken entity, DeepSaveType deepSaveType, System.Type[] childTypes, DeepSession innerList)
		{	
			if (entity == null)
				return false;
							
			#region Composite Parent Properties
			//Save Source Composite Properties, however, don't call deep save on them.  
			//So they only get saved a single level deep.
			
			#region SourceApplicationSource
			if (CanDeepSave(entity, "ApplicationDefination|SourceApplicationSource", deepSaveType, innerList) 
				&& entity.SourceApplicationSource != null)
			{
				DataRepository.ApplicationDefinationProvider.Save(transactionManager, entity.SourceApplicationSource);
				entity.SourceApplication = entity.SourceApplicationSource.ApplicationKey;
			}
			#endregion 
			
			#region RealmSource
			if (CanDeepSave(entity, "Realm|RealmSource", deepSaveType, innerList) 
				&& entity.RealmSource != null)
			{
				DataRepository.RealmProvider.Save(transactionManager, entity.RealmSource);
				entity.Realm = entity.RealmSource.RealmId;
			}
			#endregion 
			#endregion Composite Parent Properties

			// Save Root Entity through Provider
			if (!entity.IsDeleted)
				this.Save(transactionManager, entity);
			
			//used to hold DeepSave method delegates and fire after all the local children have been saved.
			Dictionary<string, KeyValuePair<Delegate, object>> deepHandles = new Dictionary<string, KeyValuePair<Delegate, object>>();
			//Fire all DeepSave Items
			foreach(KeyValuePair<Delegate, object> pair in deepHandles.Values)
		    {
                pair.Key.DynamicInvoke((object[])pair.Value);
		    }
			
			// Save Root Entity through Provider, if not already saved in delete mode
			if (entity.IsDeleted)
				this.Save(transactionManager, entity);
				

			deepHandles = null;
						
			return true;
		}
		#endregion
	} // end class
	
	#region SecurityTokenChildEntityTypes
	
	///<summary>
	/// Enumeration used to expose the different child entity types 
	/// for child properties in <c>SecurityFoundation.Entities.SecurityToken</c>
	///</summary>
	public enum SecurityTokenChildEntityTypes
	{
		
		///<summary>
		/// Composite Property for <c>ApplicationDefination</c> at SourceApplicationSource
		///</summary>
		[ChildEntityType(typeof(ApplicationDefination))]
		ApplicationDefination,
			
		///<summary>
		/// Composite Property for <c>Realm</c> at RealmSource
		///</summary>
		[ChildEntityType(typeof(Realm))]
		Realm,
		}
	
	#endregion SecurityTokenChildEntityTypes
	
	#region SecurityTokenFilterBuilder
	
	/// <summary>
	/// A strongly-typed instance of the <see cref="SqlFilterBuilder&lt;SecurityTokenColumn&gt;"/> class
	/// that is used exclusively with a <see cref="SecurityToken"/> object.
	/// </summary>
	[CLSCompliant(true)]
	public class SecurityTokenFilterBuilder : SqlFilterBuilder<SecurityTokenColumn>
	{
		#region Constructors

		/// <summary>
		/// Initializes a new instance of the SecurityTokenFilterBuilder class.
		/// </summary>
		public SecurityTokenFilterBuilder() : base() { }

		/// <summary>
		/// Initializes a new instance of the SecurityTokenFilterBuilder class.
		/// </summary>
		/// <param name="ignoreCase">Specifies whether to create case-insensitive statements.</param>
		public SecurityTokenFilterBuilder(bool ignoreCase) : base(ignoreCase) { }

		/// <summary>
		/// Initializes a new instance of the SecurityTokenFilterBuilder class.
		/// </summary>
		/// <param name="ignoreCase">Specifies whether to create case-insensitive statements.</param>
		/// <param name="useAnd">Specifies whether to combine statements using AND or OR.</param>
		public SecurityTokenFilterBuilder(bool ignoreCase, bool useAnd) : base(ignoreCase, useAnd) { }

		#endregion Constructors
	}

	#endregion SecurityTokenFilterBuilder
	
	#region SecurityTokenParameterBuilder
	
	/// <summary>
	/// A strongly-typed instance of the <see cref="ParameterizedSqlFilterBuilder&lt;SecurityTokenColumn&gt;"/> class
	/// that is used exclusively with a <see cref="SecurityToken"/> object.
	/// </summary>
	[CLSCompliant(true)]
	public class SecurityTokenParameterBuilder : ParameterizedSqlFilterBuilder<SecurityTokenColumn>
	{
		#region Constructors

		/// <summary>
		/// Initializes a new instance of the SecurityTokenParameterBuilder class.
		/// </summary>
		public SecurityTokenParameterBuilder() : base() { }

		/// <summary>
		/// Initializes a new instance of the SecurityTokenParameterBuilder class.
		/// </summary>
		/// <param name="ignoreCase">Specifies whether to create case-insensitive statements.</param>
		public SecurityTokenParameterBuilder(bool ignoreCase) : base(ignoreCase) { }

		/// <summary>
		/// Initializes a new instance of the SecurityTokenParameterBuilder class.
		/// </summary>
		/// <param name="ignoreCase">Specifies whether to create case-insensitive statements.</param>
		/// <param name="useAnd">Specifies whether to combine statements using AND or OR.</param>
		public SecurityTokenParameterBuilder(bool ignoreCase, bool useAnd) : base(ignoreCase, useAnd) { }

		#endregion Constructors
	}

	#endregion SecurityTokenParameterBuilder
	
	#region SecurityTokenSortBuilder
    
    /// <summary>
    /// A strongly-typed instance of the <see cref="SqlSortBuilder&lt;SecurityTokenColumn&gt;"/> class
	/// that is used exclusively with a <see cref="SecurityToken"/> object.
    /// </summary>
    [CLSCompliant(true)]
    public class SecurityTokenSortBuilder : SqlSortBuilder<SecurityTokenColumn>
    {
		#region Constructors

		/// <summary>
		/// Initializes a new instance of the SecurityTokenSqlSortBuilder class.
		/// </summary>
		public SecurityTokenSortBuilder() : base() { }

		#endregion Constructors

    }    
    #endregion SecurityTokenSortBuilder
	
} // end namespace
